/*----------------------------------------------------------------------*
 *	CLASS:		Qt3Player
 *	Quantum Tic Tac Toe
 *	Copyright (c) 2004-2009 Novatia Labs, Inc.  All rights reserved.
 *----------------------------------------------------------------------*/

package com.novatialabs.qttt.engine;

/**
 * Qt3Player is an enumeration of players.
 *
 * @Author	Duane Gibson
 * @Author Friendly development resources cheerfully provided by Charles Phares.
 * @Author	$Author$
 * @Version	$Revision$
 */

public enum Qt3Player
{

    X("X"),
    O("O");

    private final String	playerName;

   /*-------------------------------------------------------------------*
    *	CONSTRUCTOR:	Qt3Player()
    *	AUTHOR:		Duane Gibson
    *	CREATION DATE:	Sat Mar  6 15:06:11 PST 2004
    *-------------------------------------------------------------------*/
   /**
    * Disabled zero-arg constructor.
    */

    private Qt3Player() {
	throw new IllegalStateException();
    } // Qt3Player()

   /*-------------------------------------------------------------------*
    *	CONSTRUCTOR:	Qt3Player()
    *	AUTHOR:		Duane Gibson
    *	CREATION DATE:	Sat Mar  6 15:05:51 PST 2004
    *-------------------------------------------------------------------*/
   /**
    * Constructs a new QT3 player with the specified name.
    */

    private Qt3Player( String name ) {
	this.playerName = name;
    } // Qt3Player()

   /*-------------------------------------------------------------------*
    *	METHOD:		toString()
    *	AUTHOR:		Duane Gibson
    *	CREATION DATE:	Sat Mar  6 15:07:10 PST 2004
    *-------------------------------------------------------------------*/
   /**
    * Represents this player as a String.
    */

    public String toString()
    {

	return this.playerName;

    } // toString()

} // class Qt3Player

